<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Copyright 2007-2008 Michele Mostarda ( michele.mostarda@gmail.com ).<a name="line.2"></a>
<FONT color="green">003</FONT>     * All Rights Reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>     *<a name="line.4"></a>
<FONT color="green">005</FONT>     * Licensed under the Apache License, Version 2.0 (the 'License');<a name="line.5"></a>
<FONT color="green">006</FONT>     * you may not use this file except in compliance with the License.<a name="line.6"></a>
<FONT color="green">007</FONT>     * You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an 'AS IS' BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    package com.asemantics.rdfcoder.model.java;<a name="line.19"></a>
<FONT color="green">020</FONT>    <a name="line.20"></a>
<FONT color="green">021</FONT>    import com.asemantics.rdfcoder.model.CodeHandler;<a name="line.21"></a>
<FONT color="green">022</FONT>    import com.asemantics.rdfcoder.model.ErrorListener;<a name="line.22"></a>
<FONT color="green">023</FONT>    import com.asemantics.rdfcoder.model.Identifier;<a name="line.23"></a>
<FONT color="green">024</FONT>    import com.asemantics.rdfcoder.parser.ObjectsTable;<a name="line.24"></a>
<FONT color="green">025</FONT>    <a name="line.25"></a>
<FONT color="green">026</FONT>    /**<a name="line.26"></a>
<FONT color="green">027</FONT>     * This interface defines the &lt;i&gt; Java Code Handler&lt;/i&gt;.<a name="line.27"></a>
<FONT color="green">028</FONT>     *<a name="line.28"></a>
<FONT color="green">029</FONT>     * A handler is responsible of receiving code analysis<a name="line.29"></a>
<FONT color="green">030</FONT>     * events and transform it in a usable format.<a name="line.30"></a>
<FONT color="green">031</FONT>     *<a name="line.31"></a>
<FONT color="green">032</FONT>     * @author Michele Mostarda (michele.mostarda@gmail.com)<a name="line.32"></a>
<FONT color="green">033</FONT>     */<a name="line.33"></a>
<FONT color="green">034</FONT>    public interface JavaCodeHandler extends CodeHandler, JavadocHandler {<a name="line.34"></a>
<FONT color="green">035</FONT>    <a name="line.35"></a>
<FONT color="green">036</FONT>        /**<a name="line.36"></a>
<FONT color="green">037</FONT>         * Expected format of the library date-time.<a name="line.37"></a>
<FONT color="green">038</FONT>         */<a name="line.38"></a>
<FONT color="green">039</FONT>        public static final String LIBRARY_DATETIME_FORMAT = "yyyy_MM_dd__HH_mm_ss";<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>        /**<a name="line.41"></a>
<FONT color="green">042</FONT>         * The package separator character.<a name="line.42"></a>
<FONT color="green">043</FONT>         */<a name="line.43"></a>
<FONT color="green">044</FONT>        public static final String PACKAGE_SEPARATOR = ".";<a name="line.44"></a>
<FONT color="green">045</FONT>    <a name="line.45"></a>
<FONT color="green">046</FONT>        /**<a name="line.46"></a>
<FONT color="green">047</FONT>         * Notifies the begin of a package parsing.<a name="line.47"></a>
<FONT color="green">048</FONT>         * The package is expected to be FULLY QUALIFIED.<a name="line.48"></a>
<FONT color="green">049</FONT>         *<a name="line.49"></a>
<FONT color="green">050</FONT>         * @param pathToPackage the path expressed as list of fragments to the package.<a name="line.50"></a>
<FONT color="green">051</FONT>         */<a name="line.51"></a>
<FONT color="green">052</FONT>        public void startPackage(Identifier pathToPackage);<a name="line.52"></a>
<FONT color="green">053</FONT>    <a name="line.53"></a>
<FONT color="green">054</FONT>        /**<a name="line.54"></a>
<FONT color="green">055</FONT>         * Notifies the end of a package parsing.<a name="line.55"></a>
<FONT color="green">056</FONT>         */<a name="line.56"></a>
<FONT color="green">057</FONT>        public void endPackage();<a name="line.57"></a>
<FONT color="green">058</FONT>    <a name="line.58"></a>
<FONT color="green">059</FONT>        /**<a name="line.59"></a>
<FONT color="green">060</FONT>         * Notifies the begin of an interface definition.<a name="line.60"></a>
<FONT color="green">061</FONT>         *<a name="line.61"></a>
<FONT color="green">062</FONT>         * @param pathToInterface the path expressed as list of fragments to the interface.<a name="line.62"></a>
<FONT color="green">063</FONT>         * @param extendedInterfaces the list of extended interfaces.<a name="line.63"></a>
<FONT color="green">064</FONT>         */<a name="line.64"></a>
<FONT color="green">065</FONT>        public void startInterface(Identifier pathToInterface, Identifier[] extendedInterfaces);<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>        /**<a name="line.67"></a>
<FONT color="green">068</FONT>         * Notifies the end of an interface.<a name="line.68"></a>
<FONT color="green">069</FONT>         */<a name="line.69"></a>
<FONT color="green">070</FONT>        public void endInterface();<a name="line.70"></a>
<FONT color="green">071</FONT>    <a name="line.71"></a>
<FONT color="green">072</FONT>        /**<a name="line.72"></a>
<FONT color="green">073</FONT>         * Notifies the begin of a class parsing.<a name="line.73"></a>
<FONT color="green">074</FONT>         * The class is expected to be FULLY QUALIFIED.<a name="line.74"></a>
<FONT color="green">075</FONT>         *<a name="line.75"></a>
<FONT color="green">076</FONT>         * @param modifiers the class modifiers.<a name="line.76"></a>
<FONT color="green">077</FONT>         * @param visibility the class visibility level.<a name="line.77"></a>
<FONT color="green">078</FONT>         * @param pathToClass the path to the class.<a name="line.78"></a>
<FONT color="green">079</FONT>         * @param extendedClass the fully qualified pathToClass of the class extended by the starting class.<a name="line.79"></a>
<FONT color="green">080</FONT>         * @param implementedInterfaces the fully qualified names for the interfaces implemented by the starting class.<a name="line.80"></a>
<FONT color="green">081</FONT>         */<a name="line.81"></a>
<FONT color="green">082</FONT>        public void startClass(<a name="line.82"></a>
<FONT color="green">083</FONT>                JavaCodeModel.JModifier[] modifiers,<a name="line.83"></a>
<FONT color="green">084</FONT>                JavaCodeModel.JVisibility visibility,<a name="line.84"></a>
<FONT color="green">085</FONT>                Identifier pathToClass,<a name="line.85"></a>
<FONT color="green">086</FONT>                Identifier extendedClass,<a name="line.86"></a>
<FONT color="green">087</FONT>                Identifier[] implementedInterfaces<a name="line.87"></a>
<FONT color="green">088</FONT>        );<a name="line.88"></a>
<FONT color="green">089</FONT>    <a name="line.89"></a>
<FONT color="green">090</FONT>        /**<a name="line.90"></a>
<FONT color="green">091</FONT>         * Notifies the end of a class parsing.<a name="line.91"></a>
<FONT color="green">092</FONT>         */<a name="line.92"></a>
<FONT color="green">093</FONT>        public void endClass();<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>        /**<a name="line.95"></a>
<FONT color="green">096</FONT>         * Notifies the begin of an enumeration class parsing.<a name="line.96"></a>
<FONT color="green">097</FONT>         *<a name="line.97"></a>
<FONT color="green">098</FONT>         * The enumeration is expected to be FULLY QUALIFIED.<a name="line.98"></a>
<FONT color="green">099</FONT>         *<a name="line.99"></a>
<FONT color="green">100</FONT>         * @param modifiers the enumeration modifiers.<a name="line.100"></a>
<FONT color="green">101</FONT>         * @param visibility the visibility level of the enumeration.<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param pathToEnumeration the fully qualified path to the enumeration.<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param elements the list of the elements of the enumeration.<a name="line.103"></a>
<FONT color="green">104</FONT>         */<a name="line.104"></a>
<FONT color="green">105</FONT>        public void startEnumeration(<a name="line.105"></a>
<FONT color="green">106</FONT>                JavaCodeModel.JModifier[] modifiers,<a name="line.106"></a>
<FONT color="green">107</FONT>                JavaCodeModel.JVisibility visibility,<a name="line.107"></a>
<FONT color="green">108</FONT>                Identifier pathToEnumeration,<a name="line.108"></a>
<FONT color="green">109</FONT>                String[] elements<a name="line.109"></a>
<FONT color="green">110</FONT>        );<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>        /**<a name="line.112"></a>
<FONT color="green">113</FONT>         * Notifies the end of the enumeration class.<a name="line.113"></a>
<FONT color="green">114</FONT>         */<a name="line.114"></a>
<FONT color="green">115</FONT>        public void endEnumeration();<a name="line.115"></a>
<FONT color="green">116</FONT>    <a name="line.116"></a>
<FONT color="green">117</FONT>        /**<a name="line.117"></a>
<FONT color="green">118</FONT>         * Notifies the parsing of an attribute.<a name="line.118"></a>
<FONT color="green">119</FONT>         *<a name="line.119"></a>
<FONT color="green">120</FONT>         * The attribute is expected to be FULLY QUALIFIED.<a name="line.120"></a>
<FONT color="green">121</FONT>         *<a name="line.121"></a>
<FONT color="green">122</FONT>         * @param modifiers the attribute modifiers.<a name="line.122"></a>
<FONT color="green">123</FONT>         * @param visibility the attribute visibility level.<a name="line.123"></a>
<FONT color="green">124</FONT>         * @param pathToAttribute the absolute path to the attribute.<a name="line.124"></a>
<FONT color="green">125</FONT>         * @param type the type of the attribute.<a name="line.125"></a>
<FONT color="green">126</FONT>         * @param value the init value for the attribute. <a name="line.126"></a>
<FONT color="green">127</FONT>         */<a name="line.127"></a>
<FONT color="green">128</FONT>        public void attribute(<a name="line.128"></a>
<FONT color="green">129</FONT>                JavaCodeModel.JModifier[] modifiers,<a name="line.129"></a>
<FONT color="green">130</FONT>                JavaCodeModel.JVisibility visibility,<a name="line.130"></a>
<FONT color="green">131</FONT>                Identifier pathToAttribute,<a name="line.131"></a>
<FONT color="green">132</FONT>                JavaCodeModel.JType type,<a name="line.132"></a>
<FONT color="green">133</FONT>                String value<a name="line.133"></a>
<FONT color="green">134</FONT>        );<a name="line.134"></a>
<FONT color="green">135</FONT>    <a name="line.135"></a>
<FONT color="green">136</FONT>        /**<a name="line.136"></a>
<FONT color="green">137</FONT>         * Notifies the parsing of a constructor.<a name="line.137"></a>
<FONT color="green">138</FONT>         *<a name="line.138"></a>
<FONT color="green">139</FONT>         * The length of paramterSize and parameterNames is the same,<a name="line.139"></a>
<FONT color="green">140</FONT>         * the association between these elements is done positionally.<a name="line.140"></a>
<FONT color="green">141</FONT>         *<a name="line.141"></a>
<FONT color="green">142</FONT>         * @param modifiers the constructor modifiers.<a name="line.142"></a>
<FONT color="green">143</FONT>         * @param visibility the visibility level for the constructor.<a name="line.143"></a>
<FONT color="green">144</FONT>         * @param signatureHashCode the signature hash code. <a name="line.144"></a>
<FONT color="green">145</FONT>         * @param parameterNames the array of parameter names.<a name="line.145"></a>
<FONT color="green">146</FONT>         * @param parameterTypes the array of parameter types.<a name="line.146"></a>
<FONT color="green">147</FONT>         * @param exceptions exceptions raised by the constructor.<a name="line.147"></a>
<FONT color="green">148</FONT>         *<a name="line.148"></a>
<FONT color="green">149</FONT>         */<a name="line.149"></a>
<FONT color="green">150</FONT>        public void constructor(<a name="line.150"></a>
<FONT color="green">151</FONT>                JavaCodeModel.JModifier[] modifiers,<a name="line.151"></a>
<FONT color="green">152</FONT>                JavaCodeModel.JVisibility visibility,<a name="line.152"></a>
<FONT color="green">153</FONT>                int signatureHashCode,<a name="line.153"></a>
<FONT color="green">154</FONT>                String[] parameterNames,<a name="line.154"></a>
<FONT color="green">155</FONT>                JavaCodeModel.JType[] parameterTypes,<a name="line.155"></a>
<FONT color="green">156</FONT>                JavaCodeModel.ExceptionType[] exceptions<a name="line.156"></a>
<FONT color="green">157</FONT>        );<a name="line.157"></a>
<FONT color="green">158</FONT>    <a name="line.158"></a>
<FONT color="green">159</FONT>        /**<a name="line.159"></a>
<FONT color="green">160</FONT>         * Notifies the parsing of a method.<a name="line.160"></a>
<FONT color="green">161</FONT>         *<a name="line.161"></a>
<FONT color="green">162</FONT>         * The method is expected to be FULLY QUALIFIED.<a name="line.162"></a>
<FONT color="green">163</FONT>         *<a name="line.163"></a>
<FONT color="green">164</FONT>         * The length of parameterSize and parameterNames is the same,<a name="line.164"></a>
<FONT color="green">165</FONT>         * the association between these elements is done positionally.<a name="line.165"></a>
<FONT color="green">166</FONT>         *<a name="line.166"></a>
<FONT color="green">167</FONT>         * @param modifiers the method modifiers.<a name="line.167"></a>
<FONT color="green">168</FONT>         * @param visibility the method visibility level.<a name="line.168"></a>
<FONT color="green">169</FONT>         * @param pathToMethod the fully qualified path to the method.<a name="line.169"></a>
<FONT color="green">170</FONT>         * @param signatureHashCode the signature hash code.<a name="line.170"></a>
<FONT color="green">171</FONT>         * @param parameterNames the array of parameter names.<a name="line.171"></a>
<FONT color="green">172</FONT>         * @param parameterTypes the array of parameter types.<a name="line.172"></a>
<FONT color="green">173</FONT>         * @param returnType the return type of the method.<a name="line.173"></a>
<FONT color="green">174</FONT>         * @param exceptions exceptions raised by the method.<a name="line.174"></a>
<FONT color="green">175</FONT>         *<a name="line.175"></a>
<FONT color="green">176</FONT>         */<a name="line.176"></a>
<FONT color="green">177</FONT>        public void method(<a name="line.177"></a>
<FONT color="green">178</FONT>                JavaCodeModel.JModifier[] modifiers,<a name="line.178"></a>
<FONT color="green">179</FONT>                JavaCodeModel.JVisibility visibility,<a name="line.179"></a>
<FONT color="green">180</FONT>                Identifier pathToMethod,<a name="line.180"></a>
<FONT color="green">181</FONT>                int signatureHashCode,<a name="line.181"></a>
<FONT color="green">182</FONT>                String[] parameterNames,<a name="line.182"></a>
<FONT color="green">183</FONT>                JavaCodeModel.JType[] parameterTypes,<a name="line.183"></a>
<FONT color="green">184</FONT>                JavaCodeModel.JType returnType,<a name="line.184"></a>
<FONT color="green">185</FONT>                JavaCodeModel.ExceptionType[] exceptions<a name="line.185"></a>
<FONT color="green">186</FONT>        );<a name="line.186"></a>
<FONT color="green">187</FONT>    <a name="line.187"></a>
<FONT color="green">188</FONT>        /**<a name="line.188"></a>
<FONT color="green">189</FONT>         * Collects the unresolved types at the end of the parsing.<a name="line.189"></a>
<FONT color="green">190</FONT>         *<a name="line.190"></a>
<FONT color="green">191</FONT>         * @param unresolvedTypes<a name="line.191"></a>
<FONT color="green">192</FONT>         */<a name="line.192"></a>
<FONT color="green">193</FONT>        public void unresolvedTypes(String[] unresolvedTypes);<a name="line.193"></a>
<FONT color="green">194</FONT>    <a name="line.194"></a>
<FONT color="green">195</FONT>        /**<a name="line.195"></a>
<FONT color="green">196</FONT>         * Preloads the given Objects Table with the objects present in the underlying model.<a name="line.196"></a>
<FONT color="green">197</FONT>         *<a name="line.197"></a>
<FONT color="green">198</FONT>         * @param objectsTable<a name="line.198"></a>
<FONT color="green">199</FONT>         */<a name="line.199"></a>
<FONT color="green">200</FONT>        //TODO: LOW - Integrate preloading.<a name="line.200"></a>
<FONT color="green">201</FONT>        public void preloadObjectsFromModel(ObjectsTable objectsTable);<a name="line.201"></a>
<FONT color="green">202</FONT>    <a name="line.202"></a>
<FONT color="green">203</FONT>        /**<a name="line.203"></a>
<FONT color="green">204</FONT>         * Adds an error listener to the code handler.<a name="line.204"></a>
<FONT color="green">205</FONT>         * @param errorListener<a name="line.205"></a>
<FONT color="green">206</FONT>         */<a name="line.206"></a>
<FONT color="green">207</FONT>        public void addErrorListener(ErrorListener errorListener);<a name="line.207"></a>
<FONT color="green">208</FONT>    <a name="line.208"></a>
<FONT color="green">209</FONT>        /**<a name="line.209"></a>
<FONT color="green">210</FONT>         * Removes an error listener from the code handler.<a name="line.210"></a>
<FONT color="green">211</FONT>         * @param errorListener<a name="line.211"></a>
<FONT color="green">212</FONT>         */<a name="line.212"></a>
<FONT color="green">213</FONT>        public void removeErrorListener(ErrorListener errorListener);<a name="line.213"></a>
<FONT color="green">214</FONT>    <a name="line.214"></a>
<FONT color="green">215</FONT>    }<a name="line.215"></a>




























































</PRE>
</BODY>
</HTML>
